/*****************************************************************************
* File Name: flash.h
*
* Version: 1.0
*
* Description:
* This file contains API for storing the parameter in the flash
*
* Note:
* Define DISABLE_FLASH in platform.h to disable flash module
*
* Owner: MRAO
* 
* Related Document:
* System Reference Guide
*
* Hardware Dependency:
* 
*
* Code Tested With:
* 1. PSoC Creator 3.1 
* 2. ARM GCC 4.8.4
******************************************************************************
* Copyright (2015), Cypress Semiconductor Corporation.
******************************************************************************
* This software is owned by Cypress Semiconductor Corporation (Cypress) and is
* protected by and subject to worldwide patent protection (United States and
* foreign), United States copyright laws and international treaty provisions.
* Cypress hereby grants to licensee a personal, non-exclusive, non-transferable
* license to copy, use, modify, create derivative works of, and compile the
* Cypress Source Code and derivative works for the sole purpose of creating
* custom software in support of licensee product to be used only in conjunction
* with a Cypress integrated circuit as specified in the applicable agreement.
* Any reproduction, modification, translation, compilation, or representation of
* this software except as specified above is prohibited without the express
* written permission of Cypress.
*
* Disclaimer: CYPRESS MAKES NO WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, WITH
* REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 
* Cypress reserves the right to make changes without further notice to the
* materials described herein. Cypress does not assume any liability arising out
* of the application or use of any product or circuit described herein. Cypress
* does not authorize its products for use as critical components in life-support
* systems where a malfunction or failure may reasonably be expected to result in
* significant injury to the user. The inclusion of Cypress' product in a life-
* support systems application implies that the manufacturer assumes all risk of
* such use and in doing so indemnifies Cypress against all charges. Use may be
* limited by and subject to the applicable Cypress software license agreement.
*****************************************************************************/
#include "platform.h"

#ifndef DISABLE_FLASH
/*****************************************************************************
* Function Name: Flash_Save()
******************************************************************************
* Summary:
* This function is used to store the data into the flash
*
* Parameters:
* uint8 *srcBuf - pointer to the source buffer 
* uint8 *flashPtr - pointer to the variable in the flash
* uint8 byteCount - number of the bytes to be written 
*
* Return:
* bool - true if flash write is successful 
*
* Note:
* 1) It is the user responsibility to the make sure the buffer allocated for the flash and 
* source buffer is equal or more than the byte count.
* 2) The first byte need to be checksum
*****************************************************************************/
extern bool Flash_Save(uint8 *srcBuf, const uint8 flashPtr[], uint32 byteCount);

/*****************************************************************************
* Function Name: Flash_Load()
******************************************************************************
* Summary:
* This function is used to restore the data in the flash to the RAM buffer
*
* Parameters:
* uint8 *flashPtr - pointer to the variable in the flash
* uint8 *destBuf - pointer to the source buffer
* uint8 byteCount - number of the bytes to be written 
*
* Return:
* None
*
* Note:
* 1) It is the user responsibility to the make sure the buffer allocated for the flash and 
* source buffer is equal or more than the byte count.
* 2) The first byte need to be checksum
*****************************************************************************/
extern bool Flash_Load(const uint8 flashPtr[], uint8 *destBuf, uint32 byteCount);

#else
#define Flash_Save(srcBuf, flashPtr, byteCount)                    (true)
#define Flash_Load(flashPtr,srcBuf,byteCount)                      (true)
#endif /* DISABLE_FLASH */
